Skip to main content
POST
[Deprecated] Mark External Gateway Invoice As Paid

Endpoint Overview

POST https://api.unibee.dev/merchant/invoice/external_gateway_invoice/mark_paid Deprecated. Please use payment-level external gateway APIs: /merchant/payment/external_gateway_payment/mark_paid. This invoice-level API is kept for compatibility only.

Authorization

All UniBee Merchant API requests require authentication via API key.

Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

Request body


Request examples

cURL

Sandbox


Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success.

Error handling

When code in the response body is non-zero, check message for details. Use requestId when contacting support.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Deprecated. Please use payment-level external gateway APIs: /merchant/payment/external_gateway_payment/mark_paid. This invoice-level API is kept for compatibility only.

externalTransactionId
string<string>
required

External payment transaction id from gateway, used as idempotent key

invoiceId
string<string>
required

Invoice id

signature
string<string>
required

HMAC-SHA256(gatewayKey, invoiceId|externalTransactionId|timestamp), hex-encoded

timestamp
integer<int64>
required

Request timestamp, UTC seconds, used for expiry check

gatewayId
integer<int64>

Optional. External gateway id; omit to use invoice's current gateway for auth

metadata
object

Additional metadata from external gateway

paidTime
integer<int64>

Paid time, UTC timestamp in seconds (optional, default now)

Response

200 - application/json
code
integer<int>
data
object
merchantId
integer<int64>
message
string<string>
redirect
string<string>
requestId
string<string>